Vcenter NamespaceManagement Clusters ContentLibrarySpec

Vcenter NamespaceManagement Clusters ContentLibrarySpec
Vcenter NamespaceManagement Clusters ContentLibrarySpec

The Vcenter NamespaceManagement Clusters ContentLibrarySpec schema contains the specification required to configure Content Libraries with a Supervisor.

This schema was added in vSphere API 8.0.2.0.

JSON Example
{
    "content_library": "string",
    "supervisor_services": [
        "string"
    ],
    "resource_naming_strategy": "string"
}
string
content_library
Required

Content Library ID associated with a Supervisor. The Content Library specified should exist in the vSphere inventory.

This property was added in vSphere API 8.0.2.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.Library.

array of string
supervisor_services
Optional

List of Supervisor Service IDs that are currently making use of the Content Library. A Content Library can be used by one or more Supervisor Services. Vcenter NamespaceManagement Clusters ContentLibrarySpec.supervisor_services holds a list of Vcenter NamespaceManagement SupervisorServices Summary.supervisor_service which is used to identify the Supervisor Services that are making use of this Content Library.

If a Supervisor Service is specified, the Supervisor Service ID will be added as a label with key services.supervisor.vmware.com/Service-ID to the Content Library resources on the supervisor. For example, the label for vSphere Kubernetes Service with ID as kubernetes.vmware.com will be services.supervisor.vmware.com/kubernetes.vmware.com: "" . Supervisor Services can use this label to identify the images in the Content Library.

Note: When associating content libraries with vSphere Kubernetes Service (VKS), use Service ID kubernetes.vmware.com instead of the installed Service ID tkg.vsphere.vmware.com to ensure successful association of content libraries with VKS.

Note that linking a Content Library to a Supervisor Service does not limit the Content Library from being used by other services on the supervisor. This label will be applied on the following kubernetes resources on the Supervisor

  • clustercontentlibrary(cclib) resource managed by WCP service
  • clustercontentlibraryitem(cclitem) resource managed by Image Registry Operator
  • clustervirtualmachineimage(cvmi) resource managed by VM Operator If missing or null, no labels as described above will be added to the Content Library resources on the supervisor.

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.namespace_management.SupervisorService. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.

string
resource_naming_strategy
Optional

The resource naming strategy that is used to generate the Kubernetes resource names for images from this Content Library.

An InvalidArgument error will be thrown from POST /vcenter/namespace-management/clusters/{cluster}?action=enable operation, PATCH /vcenter/namespace-management/clusters/{cluster} operation, and PUT /vcenter/namespace-management/clusters/{cluster} operation if this resource_naming_strategy is changed on an existing Content Library associated with the Supervisor, or set to Vcenter NamespaceManagement Clusters ResourceNamingStrategy.PREFER_ITEM_SOURCE_ID on a subscribed Content Library from a published Content Library that is either also associated with the Supervisor or has another subscribed Content Library associated to the Superivsor with the resource_naming_strategy also set to Vcenter NamespaceManagement Clusters ResourceNamingStrategy.PREFER_ITEM_SOURCE_ID.

For more information see: Vcenter NamespaceManagement Clusters ResourceNamingStrategy.

This property was added in vSphere API 9.0.0.0.

If missing or null, Kubernetes resource names for images from this Content Library will be generated based on the default naming strategy Vcenter NamespaceManagement Clusters ResourceNamingStrategy.FROM_ITEM_ID.

Property Of